home *** CD-ROM | disk | FTP | other *** search
/ Aminet 19 / Aminet 19 (1997)(GTI - Schatztruhe)[!][Jun 1997].iso / Aminet / comm / fido / AFManager.lha / AFM / Areafixman.doc < prev    next >
Text File  |  1994-12-17  |  13KB  |  299 lines
  1.  
  2.                                   __  ___
  3.                                   |_)( |_)
  4.                                   |  _)| \
  5.                                S O F T W A R E
  6. _____________________________________________________________________________
  7.  
  8. Presents....: AreaFix Manager (AFM)
  9. Description.: An Arexx script to handle AreaFixes
  10. Requirement.: Registered copy of Spot
  11. Version.....: 3.0
  12. Date........: 01/08/94
  13. Status......: Freeware.   
  14. Contribution: n/a
  15. Acknowledge.: Spot, Nico Francois; Arexx, William S. Hawes
  16. _____________________________________________________________________________
  17.  
  18.   "It is custom with new users to send their areafixes to the largest
  19.    of the echoes available to them..."
  20.  
  21. Brief _______________________________________________________________________
  22.  
  23. AreaFix Manager, or AFM is an Arexx script for use with Spot which automizes
  24. the sending of AreaFixes.  A preference file is created and modified to hold
  25. the password and name of area, for each of your netmail areas so that to send
  26. a netmail, you simply have to enter the echoes you wish to attach and detach
  27. to/from.
  28.  
  29. NEW FEATURES
  30. ¯¯¯¯¯¯¯¯¯¯¯¯
  31. o Attach much simpler, via Areafix area list
  32.  
  33. FEATURES
  34. ¯¯¯¯¯¯¯¯
  35. o Remembers password and boss address for every netmail (matrix area)
  36. o Simple to use menu
  37. o Allows you to enter up to 15 attaches/detaches per message
  38. o Area list may be requested from within AFM
  39. o Detaching via list of areas
  40. o Works with most Areafix programs, easily customizable to different
  41.   Areafix names ie, Areafix, Areamanager etc.
  42. o Optional comment for each area which appears on the options menu.
  43. o Allows any password line option to be used (thanks to Richard
  44.   Galezowski)
  45.  
  46. UPGRADING
  47. ¯¯¯¯¯¯¯¯¯
  48. o No special upgrading required from version 2.9
  49. See Upgrading below...
  50.  
  51. Usage _______________________________________________________________________
  52.  
  53. INSTALLING AFM
  54. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  55. The script can be copied to where you keep all of your Spot scripts (usually
  56. REXX:Spot).  For descriptions on how to run/install the Arexx script in the
  57. Arexx menu, see the Spot documentation.
  58.  
  59. SETTING UP AFM
  60. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  61. To use AFM you simply select the menu option like any other (providing you
  62. have chosen to install the script as instructed above.) Once you have done
  63. this you may be told a number of things such as "Do not use from arealist".
  64. AFM is designed to be used from the Message List screen or the Message
  65. reading screen.  Also, it should be used from Netmail areas (these are by
  66. default labelled NET_xxxxx, where xxxxx is your address).  It MAY be called
  67. from other areas, but this is not wise as it will tell everyone who gets that
  68. area your password so that they can pretend to be you!
  69.  
  70. Once inside your netmail area, simply call the program.  You will probably be
  71. told "A new prefs file has been created" or else that the program cannot
  72. create the file.  If it is the latter, make sure there is an assign called
  73. ENVARC:  and ENV:.  Click on 'Ok' and you will be asked for the address of
  74. your boss.  Whatever you do, DO NOT type in the road and city of your
  75. employer :-).  What it requires is for you to enter the person who sends you
  76. your mail's address ie.  2:253/516 is mine.  Enter it in and press Return or
  77. click on 'Ok' and another window will pop up.  This is for your password.
  78.  
  79. Enter the password you have arranged with your boss to use.  Beware, make
  80. sure that this is the correct one as you will have two, one for use with your
  81. mailer (ie.  Trapdoor) and one for use with Areafix - but often these are the
  82. same.  Check first though.  Once you have entered the password in, hit Return
  83. or click 'Ok'.
  84.  
  85. The next piece of information you must enter is the name of the Areafix
  86. program.  This is the name which you would send Areafixes to, the name you
  87. use in the 'to' field.  Usually this is 'Areafix' (the default) although you
  88. may change it to whatever your board uses.  Simply hit Return or click 'Ok'
  89. to keep the default setting.
  90.  
  91. The next window will ask you for an optional comment.  This comment will
  92. appear on the menu and is useful for reminding you which board the areafix
  93. will go to, and whether the area is Fidonet or Amiganet etc.  It may be left
  94. blank where it will be replaced with 'Options'.
  95.  
  96. AreaFixMan also has an 'announce' feature which sends a message to each area
  97. as you detach from them.  See the using AFM section for details on how it
  98. works.
  99.  
  100. You will be asked if you want to add the details to your prefs file.  Select
  101. 'Use' to save your settings to RAM:  this will mean that they will be erased
  102. when you reboot.  Selecting 'Save' will save the settings to disk so that
  103. they are used every time you load AreaFixMan.  This works the same way as the
  104. WB2.0+ prefs settings.  If you later find that the details are wrong, delete
  105. the files ENVARC:AreaFixMan.prefs and ENV:AreaFixMan.prefs and do this
  106. 'Setting Up' section again.  'Cancel' will result in the password etc.  not
  107. being saved, so you will need to repeat the above section next time.  If you
  108. do not wish to send an AreaFix now, simply click on 'Cancel' from the
  109. attach/detach menu that follows.
  110.  
  111. USING AFM
  112. ¯¯¯¯¯¯¯¯¯
  113. Once you have set AFM up it is done forever!  Or until you need to change
  114. something where you will have to delete the prefs file and start again.
  115. After setting up, or when you select AFM from the menu, you will be presented
  116. with a requester with four options.  Your comment, if you chose to have one,
  117. will be shown in the title bar.
  118.  
  119. Attach brings up a requester where you must select either to attach manually
  120. (type the name of the areas) or via the message.  This second option is
  121. extremely useful, it allows you to attach to areas via the list of areas
  122. which is usually requestable from your boss (see below).
  123.  
  124. Attaching manually brings up a string requester where you can type the area
  125. you want to attach to (don't type '+' or '-' before it!).  After entering one
  126. in and hitting Return or clicking 'Ok' the requester will re-appear allowing
  127. you to add multiple areas.  When you have done, click 'Ok' or hit Return on
  128. an empty requester, or else click 'Cancel'.  You will be taken back to the
  129. requester where you can decide to attach/detach further areas.
  130.  
  131. To attach via a message, you must go to the appropriate message before
  132. running AFM.  Select the appropriate option and then you will be taken to the
  133. Workbench and Ed will be loaded, the current message will then be loaded.  To
  134. select the areas, simply place a '~' (tilde) character directly before its
  135. name as shown below:
  136.  
  137.     blabla Spot           | Area for general Spot discussion
  138.  
  139.   Would become:
  140.  
  141.     blabla~Spot           | Area for general Spot discussion
  142.  
  143.   This can be done for up to 15 areas.
  144.  
  145. Detaching is even easier and is done via an arealist.  A small window will
  146. pop up from which you can select an area to detach from.  The requester will
  147. repeatedly pop up until cancel is selected, so when you have finished, select
  148. CANCEL.  As soon as you have selected okay to detach from an area, a message
  149. will be placed in the area if you have announcment switched on.  This message
  150. can be anything you like and is found in Rexx:Spot (edit the variable line in
  151. the script if this is not suitable) and is called AreaFixMan.announce.  A
  152. sample announcement has been included.  Whether you ultimately decide to
  153. ERASE any detaches, or to CANCEL the whole AFM session altogether the
  154. announcement will still be there, so it will be necessary to remove them
  155. manually if this is the happens.
  156.  
  157. When you have finished, simply select OKAY.  You will be asked if you want to
  158. request an arealist.  If your board supports it, you can click 'Yes' and then
  159. you will receive a list of all the areas available to you when your boss
  160. board has processed the message.  Even if you haven't attached to, or
  161. detached from ANY areas, you can still 'claim' your free arealist...simply
  162. send back the 'Yes' envelope...or better still click on 'Yes' when you are
  163. asked if you want one :-).  Also, by selecting 'Other' from the arealist
  164. requester, you can enter in any other options such as '-H' for help or '-Q'
  165. for a query list IF, and only if, your board supports it.  Make any changes
  166. additions etc and select 'Okay' to keep the new password line options or
  167. 'Cancel' which will abort the message.
  168.  
  169. The last option from the requester arealist requester is CANCEL which will
  170. simply abort the message.
  171.  
  172. After adding an entry, ie. attaching or detaching to/from and area, a
  173. new option will become available.  This is called 'Erase' and will erase
  174. the last entry in the list when clicked upon (or activated via the
  175. keyboard equivalent 'E').  Repeatedly selecting this option will erase
  176. the last entry until the list is empty when the ERASE option will
  177. again disappear.
  178.  
  179. There is a maximum of 15 entries permitted.  This is not because it is
  180. impossible to add any more, but because the requester get's a little too big
  181. and clumsy if it exceeds this size.  When you reach the 15 entry limit, the
  182. 'Attach' and 'Detach' options will disappear and you will be left with
  183. 'Erase', 'OKAY' and 'CANCEL'.
  184.  
  185. EXAMPLE
  186. ¯¯¯¯¯¯¯
  187. Here's an example.  If I wanted to set up AFM:
  188.  
  189. 1) Enter my Netmail area.
  190. 2) Select AreaFixMan from the menu.
  191. 3) I will be told a new prefs file has been created. Click on okay.
  192. 4) Enter my boss number into requester.
  193. 5) Enter password into requester.
  194. 6) Hit RETURN to accept 'Areafix' as the TO field of Areafix messages.
  195. 7) Select OKAY to not have a comment.
  196. 8) Select SAVE to save the prefs.
  197. 9) Select cancel so that a message is not sent to Areafix.
  198.  
  199. Now if I wanted to attach to the Spot echo:
  200.  
  201. 1) Enter my Netmail area
  202. 2) Select AreaFixMan from the menu.
  203. 3) Select 'Attach' from the requester.
  204. 4) Enter the Spot echo and hit RETURN.
  205. 5) Hit return on the next blank requester to come around.
  206. 6) Select 'Okay'.
  207.  
  208. And I wanted an arealist:
  209.  
  210. 7) Select 'Yes' to requester.
  211.  
  212. The message would then be the last in the area.  If you want to
  213. cancel it, just delete the message.
  214.  
  215. Or, if I wanted to abort before stage 6.
  216.  
  217. 6) Select 'Cancel' from requester.
  218.  
  219. o The areafix created will be placed into the current area.
  220.  
  221. NOTE FOR MULTI-BOSSING USERS
  222. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  223. AreaFixMan is intelligent enough to differentiate between multiple netmail
  224. areas.  It will record the name of the area (it's REAL name) when you enter
  225. the boss' address and your password.  Whenever you use AreaFixMan in that
  226. area, the appropriate details will be recalled each time...good init?
  227.  
  228. UPGRADING
  229. ¯¯¯¯¯¯¯¯¯
  230. Upgrading from versions prior to 2.6, it is necessary to delete the config
  231. file and start from scratch...sorry!
  232.  
  233. From 2.6, no modifications are necessary as I've now discovered the benefits
  234. of future compatible config files although manual modifactions are needed to
  235. take advantage of new features.
  236.  
  237. To use 'announcement' on the 2.6 style config (you can tell this by viewing
  238. the config file and looking for the 'format 2.6' line,) you must edit the
  239. config file using an editor such as Commodore's Ed.  To activate
  240. announcement, simply type 'Announce' after the last line of each area's
  241. config which is the comment line (appears as 'Options' if you did not select
  242. a comment).  Please leave a blank line after each area, including the last
  243. for example:
  244.  
  245. -- start
  246. FORMAT 2.6
  247. NET_2_254_149_3
  248. 2:254/149
  249. password
  250. Areafix
  251. Port of Call FIDONET
  252. Announce
  253.  
  254. -- end
  255.  
  256. To disable 'Announcement' put 'No Announce'.  Although ommiting this will do
  257. the same, it is advised you add it in as it will make future upgrading much
  258. easier.
  259.  
  260. If this all seems to complicated then simply delete your config and start
  261. again from scratch, you will then be asked whether you would like
  262. announcement.
  263.  
  264. Future Enhancements _________________________________________________________
  265.  
  266. o None that I can think of at the mo :-)
  267.  
  268. Disclaimer __________________________________________________________________
  269.  
  270. o I am not responsible to any damage caused through the use or misuse
  271.   of this product and so it must only be used at your own risk.  All
  272.   efforts have been made to ensure the stability of the program but
  273.   this does not mean it is 100% safe.  Please backup any important data
  274.   that could be damaged through the use of this software until you are
  275.   sure that it is stable...Amen.
  276.  
  277. Donations/Comments __________________________________________________________
  278.  
  279. Any comments or donations can be sent to:
  280.  
  281.  PSR Software
  282.  Paul Ruane
  283.  26 Birdwood Close,
  284.  Selsdon, Surrey.
  285.  CR2 8QG.
  286.  
  287. I may also be contacted at the following addresses as Paul Ruane:
  288.  
  289.  Fidonet_____
  290.  2:252/149.3
  291.  2:253/516.12
  292.  
  293.  Amiganet____
  294.  39:135/14.3
  295.  39:135/13.12
  296.  
  297.  
  298. [end]
  299.